调用该接口,查询一体化以图搜图任务列表。
使用限制
- 单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为100。说明 RAM用户共享阿里云账号配额。
- 请提前在V系列边缘一体机上部署人脸和人体检测算法。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | QueryPictureSearchJob | 系统规定参数。取值:QueryPictureSearchJob。 |
AppInstanceId | String | 是 | fdc576d03c094faea9fa10fbf48c**** | 以图搜图应用实例ID。可调用QueryPictureSearchApps查询。 |
CurrentPage | Integer | 是 | 1 | 指定从返回结果中的第几页开始显示。最小取值为1。 |
PageSize | Integer | 是 | 10 | 返回结果中,每页显示的记录数量。最大取值50,最小取值1,默认取值为10。 |
JobStatus | Integer | 否 | 3 | 任务状态:
说明 若不设置此参数,表示选择所有状态。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
Code | String | 200 | 接口返回码:
|
Data | Struct | 调用成功时,返回的数据。 |
|
CurrentPage | Integer | 1 | 当前页码。 |
PageCount | Integer | 1 | 总页数。 |
PageData | Array of pageData | 一体化以图搜图任务列表。 |
|
CreateTime | Long | 1614850763000 | 创建一体化以图搜图任务的时间,格式为13位时间戳,单位为毫秒。 |
EndTime | Long | 1614850763692 | 检索结束时间,格式为13位时间戳,单位为毫秒。 |
JobId | String | b3786935a71442efae014c7b2212**** | 一体化以图搜图任务ID。 |
JobStatus | Integer | 3 | 任务状态:
|
SearchPicUrl | String | https://example.com/test.jpg | 检索图片的地址。 |
StartTime | Long | 1614814763692 | 检索起始时间,格式为13位时间戳,单位为毫秒。 |
Threshold | Float | 0.5 | 人脸检索相似度。 |
PageSize | Integer | 10 | 每页显示的条数。 |
Total | Integer | 2 | 一体化以图搜图任务总数。 |
ErrorMessage | String | Specified access key is not found. | 调用失败时,返回的出错信息。 |
RequestId | String | 8FAF4001-2A53-46DF-B83E-306B8070E131 | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功:
|
示例
请求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryPictureSearchJob
&AppInstanceId=fdc576d03c094faea9fa10fbf48c****
&CurrentPage=1
&PageSize=10
&<公共请求参数>
正常返回示例
XML
格式
<QueryPictureSearchJobResponse>
<RequestId>8FAF4001-2A53-46DF-B83E-306B8070E131</RequestId>
<Data>
<PageSize>10</PageSize>
<PageCount>1</PageCount>
<CurrentPage>1</CurrentPage>
<Total>1</Total>
<PageData>
<JobStatus>3</JobStatus>
<EndTime>1614850763692</EndTime>
<CreateTime>1614850763000</CreateTime>
<StartTime>1614814763692</StartTime>
<SearchPicUrl>https://example.com/test.jpg</SearchPicUrl>
<JobId>b3786935a71442efae014c7b2212****</JobId>
<Threshold>0.5</Threshold>
</PageData>
</Data>
<Code>200</Code>
<Success>true</Success>
</QueryPictureSearchJobResponse>
JSON
格式
{
"RequestId": "8FAF4001-2A53-46DF-B83E-306B8070E131",
"Data": {
"PageSize": "10",
"PageCount": "1",
"CurrentPage": "1",
"Total": "1",
"PageData": [
{
"JobStatus": "3",
"EndTime": "1614850763692",
"CreateTime": "1614850763000",
"StartTime": "1614814763692",
"SearchPicUrl": "https://example.com/test.jpg",
"JobId": "b3786935a71442efae014c7b2212****",
"Threshold": "0.5"
}
]
},
"Code": "200",
"Success": "true"
}
文档内容是否对您有帮助?